Adding trait example into documentation. #75

vrkansagara · 2021-04-14T15:17:27Z

Q	A
Documentation	yes
Bugfix	no
BC Break	no
New Feature	no
RFC	no
QA	no

Description

adding example for the issue Examples for Trait generator #24

Adding example for issue laminas#24

vrkansagara · 2021-04-14T15:20:38Z

Ping @michalbundyra

Ocramius · 2021-04-14T15:35:53Z

4091991 should probably not be part of this patch: was the patch started from this branch?

vrkansagara · 2021-04-14T16:03:32Z

yes @Ocramius , I think there is some webhook executed by @michalbundyra which add 4091991

Ocramius · 2021-04-14T16:52:09Z

@vrkansagara nay, that commit is in master and 3.4.x since a while - I think the edit was simply done starting from the wrong branch. No big deal, but requires manual merge, rather than merge from here.

froschdesign

Unfortunately, too much was copied from a previous section. Some corrections are needed.

froschdesign · 2021-04-14T17:31:50Z

docs/book/generator/examples.md

+`Laminas\Code\Generator\FileGenerator` can be used to generate the contents of a *PHP* file. You can
+include classes as well as arbitrary content body.


These two sentences are copied from the section "Generating PHP files" and it does not the describe the generating of a trait.

froschdesign · 2021-04-14T17:44:44Z

docs/book/generator/examples.md

+```php
+use Laminas\Code\Generator\FileGenerator;
+use Laminas\Code\Generator\TraitGenerator;
+
+$traitclass = new TraitGenerator();
+$traitclass->addMethod('MethodOne');
+$traitclass->addConstant('VERSION','1.0.0');
+
+$traitFile = new Laminas\Code\Generator\FileGenerator();
+$traitFile->setClass($traitclass);
+
+```


The code example can be shortened to the essentials.

Suggested change

```php

use Laminas\Code\Generator\FileGenerator;

use Laminas\Code\Generator\TraitGenerator;

$traitclass = new TraitGenerator();

$traitclass->addMethod('MethodOne');

$traitclass->addConstant('VERSION','1.0.0');

$traitFile = new Laminas\Code\Generator\FileGenerator();

$traitFile->setClass($traitclass);

```

```php

$trait = new Laminas\Code\Generator\TraitGenerator();

$trait->setName('TranslatorAwareTrait');

$trait->addProperty(

'translator', // Name

null, // Default value

Laminas\Code\Generator\PropertyGenerator::FLAG_PRIVATE // Flags

);

$trait->addMethod(

'getTranslator', // Name

[], // Parameters

Laminas\Code\Generator\PropertyGenerator::FLAG_PUBLIC, // Flags

'return $this->translator;' // Body

);

echo $trait->generate();

I think the use statements could still be handy - though I admit I don't know how the rest of the documentation is structured and if there's a standard or not.

Edit: never-mind ignore me :) - I see the classes are fully qualified

froschdesign · 2021-04-14T17:49:26Z

docs/book/generator/examples.md

+Calling `generate()` will generate the code -- but not write it to a file. You will need to capture
+the contents and write them to a file yourself. As an example:
+
+```php
+$code = $traitFile->generate();
+file_put_contents('Trait.php', $traitclass);
+```
+
+The above will generate the following file:
+
+```php
+<?php
+
+trait 
+{
+    public const VERSION = '1.0.0';
+
+    public function MethodOne()
+    {
+    }
+}
+
+```


Suggested change

Calling `generate()` will generate the code -- but not write it to a file. You will need to capture

the contents and write them to a file yourself. As an example:

```php

$code = $traitFile->generate();

file_put_contents('Trait.php', $traitclass);

```

The above will generate the following file:

```php

<?php

trait

{

public const VERSION = '1.0.0';

public function MethodOne()

{

}

}

```

The code generator produces the following trait:

```php

trait TranslatorAwareTrait

{

private $translator = null;

public function getTranslator()

{

return $this->translator;

}

}

RSully · 2021-04-15T14:13:44Z

Is it possible to add code to the body of a generated trait method? That would seem important and is missing from these examples, and part of why I made my initial request.

vrkansagara · 2021-04-15T14:27:27Z

Is it possible to add code to the body of a generated trait method? That would seem important and is missing from these examples, and part of why I made my initial request.

@RSully I have already explained here 847be56#diff-3d8f5388de37ae1d660bf9198127eb4e4a7d0796e5cd53fab4d602293b388371R406

RSully · 2021-04-15T14:34:43Z

That doesn't address my question. For example, I am asking to show something like this:

trait HelloWorld {
    private $greeting = 'Hello World';

    public function sayHello() {
        echo $this->greeting;
    }
}

Also, according to a quick test in PHP 8, traits cannot have constants - so your example's generated code doesn't compile.

Fatal error: Traits cannot have constants in [...]

froschdesign · 2021-04-15T16:43:17Z

@RSully

Is it possible to add code to the body of a generated trait method?

I have updated the example from above.

Ocramius · 2022-11-18T10:17:40Z

Houskeeping is here, closing :)

michalbundyra and others added 2 commits April 15, 2020 20:19

Merge branch 'copyright-update'

4091991

Adding example of trait generator

847be56

Adding example for issue laminas#24

froschdesign linked an issue Apr 14, 2021 that may be closed by this pull request

Examples for Trait generator #24

Open

froschdesign added Documentation Enhancement labels Apr 14, 2021

froschdesign requested changes Apr 14, 2021

View reviewed changes

Ocramius added the Awaiting Author Updates label Dec 7, 2021

Ocramius added the Won't Fix This will not be worked on label Nov 18, 2022

Ocramius self-assigned this Nov 18, 2022

Ocramius closed this Nov 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding trait example into documentation. #75

Adding trait example into documentation. #75

vrkansagara commented Apr 14, 2021

vrkansagara commented Apr 14, 2021

Ocramius commented Apr 14, 2021

vrkansagara commented Apr 14, 2021

Ocramius commented Apr 14, 2021

froschdesign left a comment

froschdesign Apr 14, 2021

froschdesign Apr 14, 2021 •

edited

Loading

RSully Apr 16, 2021 •

edited

Loading

froschdesign Apr 14, 2021 •

edited

Loading

RSully commented Apr 15, 2021

vrkansagara commented Apr 15, 2021

RSully commented Apr 15, 2021

froschdesign commented Apr 15, 2021

Ocramius commented Nov 18, 2022

		`Laminas\Code\Generator\FileGenerator` can be used to generate the contents of a PHP file. You can
		include classes as well as arbitrary content body.

-```php
-use Laminas\Code\Generator\FileGenerator;
-use Laminas\Code\Generator\TraitGenerator;
-$traitclass = new TraitGenerator();
-$traitclass->addMethod('MethodOne');
-$traitclass->addConstant('VERSION','1.0.0');
-$traitFile = new Laminas\Code\Generator\FileGenerator();
-$traitFile->setClass($traitclass);
-```
+```php
+$trait = new Laminas\Code\Generator\TraitGenerator();
+$trait->setName('TranslatorAwareTrait');
+$trait->addProperty(
+    'translator', // Name
+    null, // Default value
+    Laminas\Code\Generator\PropertyGenerator::FLAG_PRIVATE // Flags
+);
+$trait->addMethod(
+    'getTranslator', // Name
+    [], // Parameters
+    Laminas\Code\Generator\PropertyGenerator::FLAG_PUBLIC, // Flags
+    'return $this->translator;' // Body
+);
+echo $trait->generate();

Adding trait example into documentation. #75

Adding trait example into documentation. #75

Conversation

vrkansagara commented Apr 14, 2021

Description

vrkansagara commented Apr 14, 2021

Ocramius commented Apr 14, 2021

vrkansagara commented Apr 14, 2021

Ocramius commented Apr 14, 2021

froschdesign left a comment

Choose a reason for hiding this comment

froschdesign Apr 14, 2021

Choose a reason for hiding this comment

froschdesign Apr 14, 2021 • edited Loading

Choose a reason for hiding this comment

RSully Apr 16, 2021 • edited Loading

Choose a reason for hiding this comment

froschdesign Apr 14, 2021 • edited Loading

Choose a reason for hiding this comment

RSully commented Apr 15, 2021

vrkansagara commented Apr 15, 2021

RSully commented Apr 15, 2021

froschdesign commented Apr 15, 2021

Ocramius commented Nov 18, 2022

froschdesign Apr 14, 2021 •

edited

Loading

RSully Apr 16, 2021 •

edited

Loading

froschdesign Apr 14, 2021 •

edited

Loading